Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(nuxt): Add deployment-platform flow with links to docs #747

Merged
merged 5 commits into from
Dec 19, 2024

Conversation

andreiborza
Copy link
Member

We now ask where users plan to deploy their app:
Screenshot 2024-12-18 at 17 01 15@2x

For Vercel and Netlify we configure top level import of the Sentry server config file and link to docs:
Screenshot 2024-12-18 at 17 01 27@2x

For other/none we instruct people at the end to --import their Sentry server config file and link to docs:
Screenshot 2024-12-18 at 17 02 50@2x

This also improves the handling when a user's nuxt config can not be read. Instead of exiting the wizard, we continue and instruct people how to manually add it (already existed, but we bailed immediately after instructing).

Closes: #739

Copy link

github-actions bot commented Dec 18, 2024

Messages
📖 Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 31fa5d9

Copy link
Member

@s1gr1d s1gr1d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I checked the general flow of the wizard and I think it's good 👍

Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I like the idea of having this deployment provider section. Maybe something we can think of for more frameworks but it's certainly most relevant for Nuxt (and SolidStart in the future)

Comment on lines 174 to 180
if (canImportSentryServerConfigFile) {
msg += `\n\nAfter building your Nuxt app, you need to ${chalk.cyan(
'--import',
)} the Sentry server config file.\n\nFor more info see: ${chalk.cyan(
'https://docs.sentry.io/platforms/javascript/guides/nuxt/install/cli-import/#initializing-sentry-with---import',
)}`;
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

l: given that this is a pretty crucial step, I was thinking that we could make this a step that users have to confirm instead of showing this in the outro message.

So basically, print this message and make them confirm the step with an "Ok, I got it" or so. There's similar precedence for something like this in our source map wizard.

I'll leave this up to you though, so feel free to go with whatever you prefer.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, good idea! What if we (also?) opened up the docs for them with that link since it's pretty crucial that they read the info on there?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Lms24 @s1gr1d how about this?
Screenshot 2024-12-19 at 09 43 26@2x

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it! I think it's most important to have this one extra step so that people actually read what the wizard tells them, before the outro message is printed. Asking about opening docs achieves this well. Thanks!

src/nuxt/nuxt-wizard.ts Outdated Show resolved Hide resolved
Co-authored-by: Lukas Stracke <[email protected]>
@andreiborza andreiborza requested review from s1gr1d and Lms24 December 19, 2024 08:52
@andreiborza andreiborza force-pushed the ab/deployment-platform branch from f80815a to 31fa5d9 Compare December 19, 2024 09:03
Copy link
Member

@Lms24 Lms24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚢 it!

@andreiborza andreiborza merged commit 9f89026 into master Dec 19, 2024
18 checks passed
@andreiborza andreiborza deleted the ab/deployment-platform branch December 19, 2024 14:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add deployment platform inquiry and configure autoInjectServerSentry accordingly
3 participants